Feat/copy assets by joshuaunity · Pull Request #2017 · FlexMeasures/flexmeasures

joshuaunity · 2026-03-11T11:45:42Z

Description

This PR introduces an API allowing users to copy assets from one account to another, using the original account's assets as templates. The feature is currently in progress and being developed incrementally.

##TODO

Successfully Copy Assets to target account
Write a test to confirm the above feature
Write a test to confirm that asset parents and children are accurate
Successfully copy assets and asset sensors to the target account
Write a test to confirm the above feature
Successfully copy asset flexconfig... (i dont know how feasible this would be yet, mayb e 80% ?)
Write a test to confirm the above feature

Look & Feel

None

How to test

Further Improvements

Related Items

This PR closes #1966

Sign-off

I agree to contribute to the project under Apache 2 License.
To the best of my knowledge, the proposed patch is not based on code under GPL or other license that is incompatible with FlexMeasures

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

…/copy-assets

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity · 2026-03-11T11:45:55Z

CC @nhoening

read-the-docs-community · 2026-03-11T11:49:40Z

Documentation build overview

📚 flexmeasures | 🛠️ Build #31842954 | 📁 Comparing e84899e against latest (547a77b)

🔍 Preview build

Show files changed (55 files in total): 📝 55 modified | ➕ 0 added | ➖ 0 deleted

File	Status
changelog.html	📝 modified
configuration.html	📝 modified
genindex.html	📝 modified
_autosummary/flexmeasures.api.common.schemas.assets.html	📝 modified
_autosummary/flexmeasures.api.common.schemas.generic_schemas.html	📝 modified
_autosummary/flexmeasures.api.common.schemas.search.html	📝 modified
_autosummary/flexmeasures.api.common.schemas.sensor_data.html	📝 modified
_autosummary/flexmeasures.api.common.schemas.sensors.html	📝 modified
_autosummary/flexmeasures.api.common.schemas.users.html	📝 modified
_autosummary/flexmeasures.api.common.utils.api_utils.html	📝 modified
_autosummary/flexmeasures.api.v3_0.assets.html	📝 modified
_autosummary/flexmeasures.api.v3_0.sensors.html	📝 modified
_autosummary/flexmeasures.api.v3_0.users.html	📝 modified
_autosummary/flexmeasures.data.models.charts.belief_charts.html	📝 modified
_autosummary/flexmeasures.data.models.data_sources.html	📝 modified
_autosummary/flexmeasures.data.models.forecasting.model_spec_factory.html	📝 modified
_autosummary/flexmeasures.data.models.forecasting.pipelines.base.html	📝 modified
_autosummary/flexmeasures.data.models.forecasting.pipelines.predict.html	📝 modified
_autosummary/flexmeasures.data.models.generic_assets.html	📝 modified
_autosummary/flexmeasures.data.models.planning.html	📝 modified
_autosummary/flexmeasures.data.models.planning.storage.html	📝 modified
_autosummary/flexmeasures.data.models.planning.utils.html	📝 modified
_autosummary/flexmeasures.data.models.time_series.html	📝 modified
_autosummary/flexmeasures.data.schemas.account.html	📝 modified
_autosummary/flexmeasures.data.schemas.attributes.html	📝 modified
_autosummary/flexmeasures.data.schemas.forecasting.html	📝 modified
_autosummary/flexmeasures.data.schemas.forecasting.pipeline.html	📝 modified
_autosummary/flexmeasures.data.schemas.generic_assets.html	📝 modified
_autosummary/flexmeasures.data.schemas.io.html	📝 modified
_autosummary/flexmeasures.data.schemas.reporting.aggregation.html	📝 modified
_autosummary/flexmeasures.data.schemas.reporting.html	📝 modified
_autosummary/flexmeasures.data.schemas.reporting.pandas_reporter.html	📝 modified
_autosummary/flexmeasures.data.schemas.reporting.profit.html	📝 modified
_autosummary/flexmeasures.data.schemas.scheduling.html	📝 modified
_autosummary/flexmeasures.data.schemas.scheduling.metadata.html	📝 modified
_autosummary/flexmeasures.data.schemas.scheduling.process.html	📝 modified
_autosummary/flexmeasures.data.schemas.sensors.html	📝 modified
_autosummary/flexmeasures.data.schemas.sources.html	📝 modified
_autosummary/flexmeasures.data.schemas.times.html	📝 modified
_autosummary/flexmeasures.data.schemas.units.html	📝 modified
_autosummary/flexmeasures.data.schemas.utils.html	📝 modified
_autosummary/flexmeasures.data.services.forecasting.html	📝 modified
_autosummary/flexmeasures.data.services.sensors.html	📝 modified
_autosummary/flexmeasures.data.services.users.html	📝 modified
_autosummary/flexmeasures.ui.utils.breadcrumb_utils.html	📝 modified
_autosummary/flexmeasures.ui.utils.view_utils.html	📝 modified
api/v3_0.html	📝 modified
dev/automated-deploy-via-GHActions.html	📝 modified
dev/ci.html	📝 modified
dev/dependency-management.html	📝 modified
dev/docker-compose.html	📝 modified
dev/setup-and-guidelines.html	📝 modified
host/data.html	📝 modified
plugin/customisation.html	📝 modified
tut/toy-example-setup.html	📝 modified

Flix6x · 2026-03-11T13:30:26Z

Thank you for requesting a review. It looks like the scope of this PR may be mistaken? You are creating an endpoint to copy all assets under a given account*, rather than an endpoint to copy a given asset, including all assets under it.

nhoening · 2026-03-11T13:35:57Z

We can also discuss the test strategy. Joshua chose to implement a part of the solution, then tests for that, then the next part, test for that etc.

I believe we suggested initially to have one test case that tests a complete successful copy, then work on making it pass.

The test can assert the first part first (e.g. assets and subassets are copied), and others later(sensors, flex-config are copied), so you can still follow along how far you are in kaking the test pass, layer by layer.
This way would be more helpful in understanding together if the scope is agreed between all of us. The test is easier to write (I suggest using AI to help) and to read than the actual implementation.

Flix6x · 2026-03-11T13:31:50Z

flexmeasures/ui/static/openapi-specs.json

-          "20 \u00b0C",
-          "3 * 230V * 16A"
-        ]
+        "description": "Quantity string describing a fixed quantity."


This is a mistake.

flexmeasures/ui/static/openapi-specs.json

flexmeasures/api/v3_0/assets.py

Signed-off-by: Joshua Edward <oghenerobojosh01@gmail.com>

Flix6x

Thanks @joshuaunity this is now heading in the right direction. See my comments for the next challenge: a deep copy. Just let me know if any decisions come up.

Flix6x · 2026-03-16T10:10:30Z

flexmeasures/api/v3_0/assets.py

+        if account is None:
+            resolved_account = asset.owner
+            resolved_parent = asset.parent_asset
+        else:
+            resolved_account = account
+            resolved_parent = parent_asset


Let's move this to the @post_load in the schema, too.

Flix6x · 2026-03-16T10:18:43Z

flexmeasures/api/v3_0/tests/test_assets_api.py

+    assert first_copy.parent_asset_id == parent.id
+
+    # Second copy under the same parent fails: UNIQUE(name, parent_asset_id) is violated
+    # because parent_asset_id is non-NULL (PostgreSQL only treats NULLs as distinct).


PostgreSQL only treats NULLs as distinct

Interesting. So when coping twice to a NULL parent, would it be possible to then get two identically named top-level assets?

The unique constraint only applies when there is an actual ID. If both assets are without a parent, they will be created without a problem.

Flix6x · 2026-03-16T10:21:48Z

flexmeasures/api/v3_0/tests/test_assets_api.py

+    3. flex_context is preserved verbatim (sensor IDs are unchanged).
+    4. copy_asset is a *shallow* copy: the original child assets are not duplicated.


Great to see these kinds of explicit test expectations written up, thanks for that!

Assertions 3 and 4 are the opposite of what we desire, I think. That is, we want the feature to create a deep copy, by making new copies of child assets and new copies of (non-public) sensors anywhere in the underlying asset tree.

@nhoening one thing we haven't explicitly written up is whether the time series data would need to be copied, too. I vote no, to keep the scope at bay.

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Flix6x · 2026-03-17T12:43:05Z

flexmeasures/api/v3_0/assets.py

+        },
+        location="path",
+    )
+    @as_json


Please also add a decorator here to check for read access (or whatever we named that) on the asset itself.

joshuaunity added 6 commits March 5, 2026 16:25

chore: initialize repo

a886a66

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

chore: work in progress

5fc6e42

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

tests: added test to test for cpy asset feature

09e879f

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Merge branch 'main' of github.com:FlexMeasures/flexmeasures into feat…

f588302

…/copy-assets

chore: removed unused file

3f97255

refactor: relocate util function

d609e37

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

joshuaunity requested a review from Flix6x March 11, 2026 11:45

joshuaunity self-assigned this Mar 11, 2026

joshuaunity added the enhancement New feature or request label Mar 11, 2026

Flix6x requested changes Mar 11, 2026

View reviewed changes

refacto: Refactored util for copying asset

abd590b

Signed-off-by: Joshua Edward <oghenerobojosh01@gmail.com>

joshuaunity requested a review from Flix6x March 13, 2026 12:03

joshuaunity and others added 2 commits March 13, 2026 17:23

tests: and new test case

fb39eac

Signed-off-by: Joshua Edward <oghenerobojosh01@gmail.com>

Merge branch 'main' into feat/copy-assets

71810d0

Flix6x requested changes Mar 16, 2026

View reviewed changes

joshuaunity added 2 commits March 16, 2026 15:34

chore: move logic into @post_load

5371a4e

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

feat: implement deep copy of asset subtree including direct sensors

e84899e

Signed-off-by: joshuaunity <oghenerobojosh01@gmail.com>

Flix6x reviewed Mar 17, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/copy assets#2017

Feat/copy assets#2017
joshuaunity wants to merge 11 commits intomainfrom
feat/copy-assets

joshuaunity commented Mar 11, 2026 •

edited

Loading

Uh oh!

joshuaunity commented Mar 11, 2026

Uh oh!

read-the-docs-community bot commented Mar 11, 2026 •

edited

Loading

Uh oh!

Flix6x commented Mar 11, 2026

Uh oh!

nhoening commented Mar 11, 2026

Uh oh!

Flix6x Mar 11, 2026

Uh oh!

Uh oh!

Uh oh!

Flix6x left a comment

Uh oh!

Flix6x Mar 16, 2026

Uh oh!

Flix6x Mar 16, 2026

Uh oh!

joshuaunity Mar 16, 2026

Uh oh!

Flix6x Mar 16, 2026

Uh oh!

Flix6x Mar 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		3. flex_context is preserved verbatim (sensor IDs are unchanged).
		4. copy_asset is a shallow copy: the original child assets are not duplicated.

Conversation

joshuaunity commented Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Look & Feel

How to test

Further Improvements

Related Items

Sign-off

Uh oh!

joshuaunity commented Mar 11, 2026

Uh oh!

read-the-docs-community bot commented Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation build overview

Uh oh!

Flix6x commented Mar 11, 2026

Uh oh!

nhoening commented Mar 11, 2026

Uh oh!

Flix6x Mar 11, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Flix6x left a comment

Choose a reason for hiding this comment

Uh oh!

Flix6x Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

Flix6x Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

joshuaunity Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

Flix6x Mar 16, 2026

Choose a reason for hiding this comment

Uh oh!

Flix6x Mar 17, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

joshuaunity commented Mar 11, 2026 •

edited

Loading

read-the-docs-community bot commented Mar 11, 2026 •

edited

Loading